<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::Neighborhood Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_neighborhood.html">Neighborhood</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_s_p_h_1_1_neighborhood-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::Neighborhood Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A neighborhood around particle i.  
 <a href="class_s_p_h_1_1_neighborhood.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="neighbor__relation_8h_source.html">neighbor_relation.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae2ba8aefeb9a6f2c93fb7a477df21c3a"><td class="memItemLeft" align="right" valign="top"><a id="ae2ba8aefeb9a6f2c93fb7a477df21c3a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>removeANeighbor</b> (<a class="el" href="classsize__t.html">size_t</a> neighbor_n)</td></tr>
<tr class="separator:ae2ba8aefeb9a6f2c93fb7a477df21c3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a1e2d0d9c7af09e2ee0e58903b171902d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsize__t.html">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_neighborhood.html#a1e2d0d9c7af09e2ee0e58903b171902d">current_size_</a></td></tr>
<tr class="separator:a1e2d0d9c7af09e2ee0e58903b171902d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58d054540758347561bf8597445c568c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsize__t.html">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_neighborhood.html#a58d054540758347561bf8597445c568c">allocated_size_</a></td></tr>
<tr class="separator:a58d054540758347561bf8597445c568c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaec2f984f8c1afd41b2ea98ec7033f99"><td class="memItemLeft" align="right" valign="top">StdLargeVec&lt; <a class="el" href="classsize__t.html">size_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_neighborhood.html#aaec2f984f8c1afd41b2ea98ec7033f99">j_</a></td></tr>
<tr class="separator:aaec2f984f8c1afd41b2ea98ec7033f99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aead058787ca24c233d7d6d7825e1dac3"><td class="memItemLeft" align="right" valign="top">StdLargeVec&lt; Real &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_neighborhood.html#aead058787ca24c233d7d6d7825e1dac3">W_ij_</a></td></tr>
<tr class="separator:aead058787ca24c233d7d6d7825e1dac3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef11606a64385d6a5274d830349b7c82"><td class="memItemLeft" align="right" valign="top">StdLargeVec&lt; Real &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_neighborhood.html#aef11606a64385d6a5274d830349b7c82">dW_ij_</a></td></tr>
<tr class="separator:aef11606a64385d6a5274d830349b7c82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a44c2a06d377d53b39479308a86edfc"><td class="memItemLeft" align="right" valign="top">StdLargeVec&lt; Real &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_neighborhood.html#a8a44c2a06d377d53b39479308a86edfc">r_ij_</a></td></tr>
<tr class="separator:a8a44c2a06d377d53b39479308a86edfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a782ec6d5487c833710534ac48aa2e63b"><td class="memItemLeft" align="right" valign="top">StdLargeVec&lt; Vecd &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_neighborhood.html#a782ec6d5487c833710534ac48aa2e63b">e_ij_</a></td></tr>
<tr class="separator:a782ec6d5487c833710534ac48aa2e63b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A neighborhood around particle i. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a58d054540758347561bf8597445c568c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58d054540758347561bf8597445c568c">&#9670;&nbsp;</a></span>allocated_size_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsize__t.html">size_t</a> SPH::Neighborhood::allocated_size_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>the limit of neighors does not require memory allocation <br  />
 </p>

</div>
</div>
<a id="a1e2d0d9c7af09e2ee0e58903b171902d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e2d0d9c7af09e2ee0e58903b171902d">&#9670;&nbsp;</a></span>current_size_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsize__t.html">size_t</a> SPH::Neighborhood::current_size_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>the current number of neighors </p>

</div>
</div>
<a id="aef11606a64385d6a5274d830349b7c82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef11606a64385d6a5274d830349b7c82">&#9670;&nbsp;</a></span>dW_ij_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StdLargeVec&lt;Real&gt; SPH::Neighborhood::dW_ij_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>derivative of kernel function or inter-particle surface contribution </p>

</div>
</div>
<a id="a782ec6d5487c833710534ac48aa2e63b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a782ec6d5487c833710534ac48aa2e63b">&#9670;&nbsp;</a></span>e_ij_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StdLargeVec&lt;Vecd&gt; SPH::Neighborhood::e_ij_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>unit vector pointing from j to i or inter-particle surface direction </p>

</div>
</div>
<a id="aaec2f984f8c1afd41b2ea98ec7033f99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaec2f984f8c1afd41b2ea98ec7033f99">&#9670;&nbsp;</a></span>j_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StdLargeVec&lt;<a class="el" href="classsize__t.html">size_t</a>&gt; SPH::Neighborhood::j_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>index of the neighbor particle. </p>

</div>
</div>
<a id="a8a44c2a06d377d53b39479308a86edfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a44c2a06d377d53b39479308a86edfc">&#9670;&nbsp;</a></span>r_ij_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StdLargeVec&lt;Real&gt; SPH::Neighborhood::r_ij_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>distance between j and i. </p>

</div>
</div>
<a id="aead058787ca24c233d7d6d7825e1dac3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aead058787ca24c233d7d6d7825e1dac3">&#9670;&nbsp;</a></span>W_ij_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StdLargeVec&lt;Real&gt; SPH::Neighborhood::W_ij_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>kernel value or particle volume contribution </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>SPHINXsys/src/shared/particles/<a class="el" href="neighbor__relation_8h_source.html">neighbor_relation.h</a></li>
<li>SPHINXsys/src/shared/particles/neighbor_relation.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
